<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Docs For Class Madoqua_Install</title>
    <link rel="stylesheet" type="text/css" href="../media/style.css" />
    <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  </head>
  <body>
  
    <h1>Madoqua :: Docs For Class Madoqua_Install</h1>

    <table width="100%">
      <tr valign="top">
        <td class="menu">
                                <div class="package">
              <div id="todolist">
                <p><a href="../todolist.html">Todo List</a></p>
              </div>
            </div>
                    <h2>Packages:</h2>
          <div class="package">
            <ul>
                              <li>
                  <a href="../classtrees_default.html">default</a>
                </li>
                              <li>
                  <a href="../classtrees_Application.html">Application</a>
                </li>
                              <li>
                  <a href="../classtrees_Cache.html">Cache</a>
                </li>
                              <li>
                  <a href="../classtrees_Controller.html">Controller</a>
                </li>
                              <li>
                  <a href="../classtrees_Db.html">Db</a>
                </li>
                              <li>
                  <a href="../classtrees_Filter.html">Filter</a>
                </li>
                              <li>
                  <a href="../classtrees_Form.html">Form</a>
                </li>
                              <li>
                  <a href="../classtrees_Install.html">Install</a>
                </li>
                              <li>
                  <a href="../classtrees_Loader.html">Loader</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Exception.html">Madoqua_Exception</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Observer.html">Madoqua_Observer</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Plugin.html">Madoqua_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_View.html">Madoqua_View</a>
                </li>
                              <li>
                  <a href="../classtrees_Module.html">Module</a>
                </li>
                              <li>
                  <a href="../classtrees_Naneau_Plugin.html">Naneau_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Redirector.html">Redirector</a>
                </li>
                              <li>
                  <a href="../classtrees_Search.html">Search</a>
                </li>
                              <li>
                  <a href="../classtrees_Validate.html">Validate</a>
                </li>
                              <li>
                  <a href="../classtrees_View.html">View</a>
                </li>
                          </ul>
          </div>
                                                                    <h2>Classes:</h2>
                <ul>
		    		<li><a href="../Install/Madoqua_Install.html">Madoqua_Install</a></li>    	  </ul>
                              </td>
        <td>
          <table style="width:750px;" cellpadding="10" cellspacing="10px">
            <tr>
              <td valign="top">
                                                                  <h2>Install::Madoqua_Install</h2>
                                <div class="menu">
          
                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                  [ <a href="../index.html">Index</a> ]
                      [ <a href="../classtrees_Install.html">Install classes</a> ]
            [ <a href="../elementindex_Install.html">Install elements</a> ]
                    [ <a href="../elementindex.html">All elements</a> ]
          [ <a href="../errors.html">Errors</a> ]
                </div>
<a name="sec-description"></a>
<h2>Class Madoqua_Install</h2>

<p>Madoqua_Install</p><div><p>Installer class</p></div>		










  <a name="sec-var-summary"></a>
  <h2>Member Variables</h2>
  <table class="summary">
                                                                                                      <tr>
          <td class="right">
            <em>public</em>            <em>mixed</em>          </td>
          <td>
            <code>
              $canInstall
               = <span class="var-default"> true</span>            </code>
            <br /><div style="margin-left: 20px">I can has installz?</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            <em>array</em>          </td>
          <td>
            <code>
              $_directories
               = <span class="var-default">array(<br />     	'applicationConfig' =&gt; array('madoqua_private/application/config','0755'),'cache'=&gt;array('madoqua_private/data/cache','0755'),'actionsCache'=&gt;array('madoqua_private/data/cache/actions','0755'),'configCache'=&gt;array('madoqua_private/data/cache/config','0755'),'sqliteDb'=&gt;array('madoqua_private/data/database','0740'),'logs'=&gt;array('madoqua_private/data/logs','0755'),'openId'=&gt;array('madoqua_private/data/openid','0755'),'search'=&gt;array('madoqua_private/data/search','0755'),'sessions'=&gt;array('madoqua_private/data/session','0755'),'themes'=&gt;array('madoqua_private/data/mythemes','0764'))</span>            </code>
            <br /><div style="margin-left: 20px">directories that have to be writable</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            <em>array</em>          </td>
          <td>
            <code>
              $_errors
               = <span class="var-default">array()</span>            </code>
            <br /><div style="margin-left: 20px">Errors</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            <em>string</em>          </td>
          <td>
            <code>
              $_host
               = <span class="var-default"> null</span>            </code>
            <br /><div style="margin-left: 20px">Host</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            <em>string</em>          </td>
          <td>
            <code>
              $_path
               = <span class="var-default"> null</span>            </code>
            <br /><div style="margin-left: 20px">Path</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            <em>Zend_Controller_Response_Http</em>          </td>
          <td>
            <code>
              $_response
               = <span class="var-default"> null</span>            </code>
            <br /><div style="margin-left: 20px">Response objects</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            <em>string</em>          </td>
          <td>
            <code>
              $_rewriteBase
               = <span class="var-default"> '/'</span>            </code>
            <br /><div style="margin-left: 20px">Rewrite base</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            <em>Zend_View_Interface</em>          </td>
          <td>
            <code>
              $_view
               = <span class="var-default"> null</span>            </code>
            <br /><div style="margin-left: 20px">View instance</div>                      </td>
        </tr>
            </table>


  <a name="sec-method-summary"></a>
  <h2>Method Summary</h2>
  <table class="summary">
                                                                                                                                                        <tr>
          <td class="right">
            <em>public</em>                        <em><a href="../Install/Madoqua_Install.html">Madoqua_Install</a></em>          </td>
          <td>
            <code>
              <a href="#__construct"><b>__construct</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Constructor</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>Zend_Controller_Response_Http</em>          </td>
          <td>
            <code>
              <a href="#execute"><b>execute</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Execute the install</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>array</em>          </td>
          <td>
            <code>
              <a href="#getDirectories"><b>getDirectories</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Returns array of required dirs</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>Zend_Controller_Response_Http</em>          </td>
          <td>
            <code>
              <a href="#getResponse"><b>getResponse</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Return the response object</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>Zend_View</em>          </td>
          <td>
            <code>
              <a href="#getView"><b>getView</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Get the installers view object</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#htaccessInstalled"><b>htaccessInstalled</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Has .htaccess been installed and rewriting enabled?</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em><a href="../Install/Madoqua_Install.html">Madoqua_Install</a></em>          </td>
          <td>
            <code>
              <a href="#setDirectories"><b>setDirectories</b></a>(
                                                                                    $dirs
                                                 )
            </code>
            <br /><div style="margin-left: 20px">Set custom directory locations</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em><a href="../Install/Madoqua_Install.html">Madoqua_Install</a></em>          </td>
          <td>
            <code>
              <a href="#setResponse"><b>setResponse</b></a>(
                                                                  [                  $response
                   = null]                               )
            </code>
            <br /><div style="margin-left: 20px">Set the response object</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>return</em>          </td>
          <td>
            <code>
              <a href="#setView"><b>setView</b></a>(
                                                                                    $view
                                                 )
            </code>
            <br /><div style="margin-left: 20px">Set a view object for the isntaller</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#startSetup"><b>startSetup</b></a>(
               )
            </code>
                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>                        <em>$string</em>          </td>
          <td>
            <code>
              <a href="#writeConfig"><b>writeConfig</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Write the default configuration then redirect to continue install</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>                        <em>Zend_Controller_Response_Http</em>          </td>
          <td>
            <code>
              <a href="#_redirect"><b>_redirect</b></a>(
                                                                                    $location
                                                 )
            </code>
            <br /><div style="margin-left: 20px">Redirect to the give location  If an array is given, it gets imploded with a forward slash.</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>                        <em>Zend_Controller_Response_Http</em>          </td>
          <td>
            <code>
              <a href="#_render"><b>_render</b></a>(
                                                                                    $script
                                                 )
            </code>
            <br /><div style="margin-left: 20px">Render the given view script</div>          </td>
        </tr>
            </table>


  <a name="sec-methods"></a>
  <h2>Methods</h2>
  <a name='method_detail'></a>
                          
      <a name="method__construct" id="__construct"><!-- --></a>

    <h3>__construct</h3>

    <div class="method-signature">
      <a href="../Install/Madoqua_Install.html">Madoqua_Install</a>
      __construct(
      )
    </div>

    <p>Constructor</p>
    
        

    
    
    
        <a name="methodexecute" id="execute"><!-- --></a>

    <h3>execute</h3>

    <div class="method-signature">
      Zend_Controller_Response_Http
      execute(
      )
    </div>

    <p>Execute the install</p>
    
        

    
    
    
        <a name="methodgetDirectories" id="getDirectories"><!-- --></a>

    <h3>getDirectories</h3>

    <div class="method-signature">
      array
      getDirectories(
      )
    </div>

    <p>Returns array of required dirs</p>
    
        

    
    
    
        <a name="methodgetResponse" id="getResponse"><!-- --></a>

    <h3>getResponse</h3>

    <div class="method-signature">
      Zend_Controller_Response_Http
      getResponse(
      )
    </div>

    <p>Return the response object</p>
    
        

    
    
    
        <a name="methodgetView" id="getView"><!-- --></a>

    <h3>getView</h3>

    <div class="method-signature">
      Zend_View
      getView(
      )
    </div>

    <p>Get the installers view object</p>
    
        

    
    
    
        <a name="methodhtaccessInstalled" id="htaccessInstalled"><!-- --></a>

    <h3>htaccessInstalled</h3>

    <div class="method-signature">
      bool
      htaccessInstalled(
      )
    </div>

    <p>Has .htaccess been installed and rewriting enabled?</p>
    
        

    
    
    
        <a name="methodsetDirectories" id="setDirectories"><!-- --></a>

    <h3>setDirectories</h3>

    <div class="method-signature">
      <a href="../Install/Madoqua_Install.html">Madoqua_Install</a>
      setDirectories(
                                  
          $dirs
                        )
    </div>

    <p>Set custom directory locations</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$dirs</code></td>
              <td><em>array</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="methodsetResponse" id="setResponse"><!-- --></a>

    <h3>setResponse</h3>

    <div class="method-signature">
      <a href="../Install/Madoqua_Install.html">Madoqua_Install</a>
      setResponse(
                                  [
          $response
           = null]              )
    </div>

    <p>Set the response object</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$response</code></td>
              <td><em>Zend_Controller_Response_Http</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="methodsetView" id="setView"><!-- --></a>

    <h3>setView</h3>

    <div class="method-signature">
      return
      setView(
                                  
          $view
                        )
    </div>

    <p>Set a view object for the isntaller</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$view</code></td>
              <td><em>Zend_View_Interface</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="methodstartSetup" id="startSetup"><!-- --></a>

    <h3>startSetup</h3>

    <div class="method-signature">
      void
      startSetup(
      )
    </div>

    
    
        

    
    
    
        <a name="methodwriteConfig" id="writeConfig"><!-- --></a>

    <h3>writeConfig</h3>

    <div class="method-signature">
      $string
      writeConfig(
      )
    </div>

    <p>Write the default configuration then redirect to continue install</p>
    
        

    
    
    
        <a name="method_redirect" id="_redirect"><!-- --></a>

    <h3>_redirect</h3>

    <div class="method-signature">
      Zend_Controller_Response_Http
      _redirect(
                                  string|array
          $location
                        )
    </div>

    <p>Redirect to the give location  If an array is given, it gets imploded with a forward slash.</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$location</code></td>
              <td><em>string|array</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="method_render" id="_render"><!-- --></a>

    <h3>_render</h3>

    <div class="method-signature">
      Zend_Controller_Response_Http
      _render(
                                  string
          $script
                        )
    </div>

    <p>Render the given view script</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$script</code></td>
              <td><em>string</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
  
<p class="notes">
  Located in <a class="field" href="_Install.php.html">/Install.php</a> 
  [<span class="field">line 16</span>]
</p>

                <div class="credit">
                  Documentation generated on Fri, 16 Jan 2009 10:14:42 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
                </div>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
</html>